<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>fieldanalysis: GStreamer Bad Plugins 1.0 Plugins Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Plugins Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
<link rel="prev" href="gst-plugins-bad-plugins-festival.html" title="festival">
<link rel="next" href="gst-plugins-bad-plugins-fisheye.html" title="fisheye">
<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gst-plugins-bad-plugins-fieldanalysis.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#gst-plugins-bad-plugins-fieldanalysis.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#gst-plugins-bad-plugins-fieldanalysis.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gst-plugins-bad-plugins-festival.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gst-plugins-bad-plugins-fisheye.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gst-plugins-bad-plugins-fieldanalysis"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-fieldanalysis.top_of_page"></a>fieldanalysis</span></h2>
<p>fieldanalysis</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-fieldanalysis.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-fieldanalysis.html#GstFieldAnalysis--block-height" title="The “block-height” property">block-height</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-fieldanalysis.html#GstFieldAnalysis--block-threshold" title="The “block-threshold” property">block-threshold</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-fieldanalysis.html#GstFieldAnalysis--block-width" title="The “block-width” property">block-width</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">FieldAnalysisCombMethod</span></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-fieldanalysis.html#GstFieldAnalysis--comb-method" title="The “comb-method” property">comb-method</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">GstFieldAnalysisFieldMetric</span></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-fieldanalysis.html#GstFieldAnalysis--field-metric" title="The “field-metric” property">field-metric</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-fieldanalysis.html#GstFieldAnalysis--field-threshold" title="The “field-threshold” property">field-threshold</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">GstFieldAnalysisFrameMetric</span></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-fieldanalysis.html#GstFieldAnalysis--frame-metric" title="The “frame-metric” property">frame-metric</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-fieldanalysis.html#GstFieldAnalysis--frame-threshold" title="The “frame-threshold” property">frame-threshold</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-fieldanalysis.html#GstFieldAnalysis--ignored-lines" title="The “ignored-lines” property">ignored-lines</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-fieldanalysis.html#GstFieldAnalysis--noise-floor" title="The “noise-floor” property">noise-floor</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-fieldanalysis.html#GstFieldAnalysis--spatial-threshold" title="The “spatial-threshold” property">spatial-threshold</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<a name="GstFieldAnalysis"></a><div class="refsect1">
<a name="gst-plugins-bad-plugins-fieldanalysis.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-fieldanalysis.html#GstFieldAnalysis-struct" title="struct GstFieldAnalysis">GstFieldAnalysis</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-fieldanalysis.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a>
            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a>
                <span class="lineart">╰──</span> GstFieldAnalysis
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-fieldanalysis.description"></a><h2>Description</h2>
<p>Analyse fields from video buffers to identify whether the buffers are
progressive/telecined/interlaced and, if telecined, the telecine pattern
used.</p>
<div class="refsect3">
<a name="id-1.2.90.7.3"></a><h4>Example launch line</h4>
<div class="informalexample">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1</pre></td>
        <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> <span class="gtkdoc opt">-</span>v uridecodebin uri<span class="gtkdoc opt">=/</span>path<span class="gtkdoc opt">/</span>to<span class="gtkdoc opt">/</span>foo<span class="gtkdoc opt">.</span>bar <span class="gtkdoc opt">!</span> fieldanalysis <span class="gtkdoc opt">!</span> deinterlace <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> autovideosink</pre></td>
      </tr>
    </tbody>
  </table>
</div>

<p> This pipeline will analyse a video stream with default metrics and thresholds and output progressive frames.</p>
</div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<div class="refsect2">
<a name="id-1.2.90.7.4.1"></a><h3>Element Information</h3>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">plugin</span></p></td>
<td>
            <a class="link" href="gst-plugins-bad-plugins-plugin-fieldanalysis.html#plugin-fieldanalysis">fieldanalysis</a>
          </td>
</tr>
<tr>
<td><p><span class="term">author</span></p></td>
<td>Robert Swain &lt;robert.swain@collabora.co.uk&gt;</td>
</tr>
<tr>
<td><p><span class="term">class</span></p></td>
<td>Filter/Analysis/Video</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="id-1.2.90.7.4.2"></a><h3>Element Pads</h3>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>sink</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>sink</td>
</tr>
<tr>
<td><p><span class="term">presence</span></p></td>
<td>always</td>
</tr>
<tr>
<td><p><span class="term">details</span></p></td>
<td>video/x-raw, format=(string){ YUY2, UYVY, Y42B, I420, YV12 }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
</tr>
</tbody>
</table></div>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>src</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>source</td>
</tr>
<tr>
<td><p><span class="term">presence</span></p></td>
<td>always</td>
</tr>
<tr>
<td><p><span class="term">details</span></p></td>
<td>video/x-raw, format=(string){ YUY2, UYVY, Y42B, I420, YV12 }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-fieldanalysis.functions_details"></a><h2>Functions</h2>
<p></p>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-fieldanalysis.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GstFieldAnalysis-struct"></a><h3>struct GstFieldAnalysis</h3>
<pre class="programlisting">struct GstFieldAnalysis;</pre>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-bad-plugins-fieldanalysis.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GstFieldAnalysis--block-height"></a><h3>The <code class="literal">“block-height”</code> property</h3>
<pre class="programlisting">  “block-height”             <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre>
<p>Block height for windowed comb detection.</p>
<p>Flags: Read / Write</p>
<p>Default value: 16</p>
</div>
<hr>
<div class="refsect2">
<a name="GstFieldAnalysis--block-threshold"></a><h3>The <code class="literal">“block-threshold”</code> property</h3>
<pre class="programlisting">  “block-threshold”          <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre>
<p>Block threshold for windowed comb detection.</p>
<p>Flags: Read / Write</p>
<p>Default value: 80</p>
</div>
<hr>
<div class="refsect2">
<a name="GstFieldAnalysis--block-width"></a><h3>The <code class="literal">“block-width”</code> property</h3>
<pre class="programlisting">  “block-width”              <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre>
<p>Block width for windowed comb detection.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: &gt;= 1</p>
<p>Default value: 16</p>
</div>
<hr>
<div class="refsect2">
<a name="GstFieldAnalysis--comb-method"></a><h3>The <code class="literal">“comb-method”</code> property</h3>
<pre class="programlisting">  “comb-method”              <span class="type">FieldAnalysisCombMethod</span></pre>
<p>Metric to be used for identifying comb artifacts if using windowed comb detection.</p>
<p>Flags: Read / Write</p>
<p>Default value: 5-tap [1,-3,4,-3,1] vertical filter result is larger than spatial threshold*6</p>
</div>
<hr>
<div class="refsect2">
<a name="GstFieldAnalysis--field-metric"></a><h3>The <code class="literal">“field-metric”</code> property</h3>
<pre class="programlisting">  “field-metric”             <span class="type">GstFieldAnalysisFieldMetric</span></pre>
<p>Metric to be used for comparing same parity fields to decide if they are a repeated field for telecine.</p>
<p>Flags: Read / Write</p>
<p>Default value: Sum of Squared Differences</p>
</div>
<hr>
<div class="refsect2">
<a name="GstFieldAnalysis--field-threshold"></a><h3>The <code class="literal">“field-threshold”</code> property</h3>
<pre class="programlisting">  “field-threshold”          <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre>
<p>Threshold for field metric decisions.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: &gt;= 0</p>
<p>Default value: 0.08</p>
</div>
<hr>
<div class="refsect2">
<a name="GstFieldAnalysis--frame-metric"></a><h3>The <code class="literal">“frame-metric”</code> property</h3>
<pre class="programlisting">  “frame-metric”             <span class="type">GstFieldAnalysisFrameMetric</span></pre>
<p>Metric to be used for comparing opposite parity fields to decide if they are a progressive frame.</p>
<p>Flags: Read / Write</p>
<p>Default value: 5-tap [1,-3,4,-3,1] Vertical Filter</p>
</div>
<hr>
<div class="refsect2">
<a name="GstFieldAnalysis--frame-threshold"></a><h3>The <code class="literal">“frame-threshold”</code> property</h3>
<pre class="programlisting">  “frame-threshold”          <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre>
<p>Threshold for frame metric decisions.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: &gt;= 0</p>
<p>Default value: 0.002</p>
</div>
<hr>
<div class="refsect2">
<a name="GstFieldAnalysis--ignored-lines"></a><h3>The <code class="literal">“ignored-lines”</code> property</h3>
<pre class="programlisting">  “ignored-lines”            <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre>
<p>Ignore this many lines from the top and bottom for windowed comb detection.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: &gt;= 2</p>
<p>Default value: 2</p>
</div>
<hr>
<div class="refsect2">
<a name="GstFieldAnalysis--noise-floor"></a><h3>The <code class="literal">“noise-floor”</code> property</h3>
<pre class="programlisting">  “noise-floor”              <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
<p>Noise floor for appropriate metrics (per-pixel metric values with a score less than this will be ignored).</p>
<p>Flags: Read / Write</p>
<p>Default value: 16</p>
</div>
<hr>
<div class="refsect2">
<a name="GstFieldAnalysis--spatial-threshold"></a><h3>The <code class="literal">“spatial-threshold”</code> property</h3>
<pre class="programlisting">  “spatial-threshold”        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></pre>
<p>Threshold for combing metric decisions.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: &gt;= 0</p>
<p>Default value: 9</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.28</div>
</body>
</html>